feat: implement single prefix #32
Merged
+207
−130
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
manics
reviewed
Jul 19, 2024
| @@ -66,6 +67,12 @@ class MultiAuthenticator(Authenticator): | |||
| for JupyterHub""" | |||
|
|
|||
| authenticators = List(help="The subauthenticators to use", config=True) | |||
| username_prefix = Unicode( | |||
There was a problem hiding this comment.
Another option (not better/worse, just another option) is to have this as a Callable(...) which takes the authenticator as a parameter and returns the prefix, with the default being the current behaviour.
The advantage is flexibility since you could have a mix of shared and unique prefixes, the downside is someone has to define a callable instead of a string if they want a common/no prefix c.MultiAuthenticator.username_prefix=lambda a: ""
minrk
approved these changes
Oct 17, 2024
It is better to subclass the authenticator of interest and set the login_service property on the subclass. Support for service_name will be removed in a feature version.
This allows for an administrator to set a prefix that will be used for all authenticators configured. It can be useful when there's a need to use an alternate login method while keeping the same username. **WARNING: This can have security implications !!!** If two different users, using each a different login service have the same username returned (e.g. User1 on GitLab gets UserXYZ and User2 on GitHub also get UserXYZ, then they will have access to the same account on the JupyterHub deployment.
sgaist
force-pushed
the
implement_single_prefix
branch
from
5b42393 to
83ad5ed
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
This PR implement a new setting for the MultiAuthenticator class: username_prefix.
When set, only this prefix will be used across all Authenticators configured.
It can be useful when there's a need to use an alternate login method while keeping the same username.
INFO: the service_name feature is deprecated in favor of subclassing authenticator classes and setting the
login_serviceproperty. It's more verbose however it makes the intention clearer. It will be removed in a future release.WARNING: This can have security implications !!!
If two different users, using each a different login service have the same username returned (e.g. User1 on GitLab gets UserXYZ and User2 on GitHub also get UserXYZ, then they will have access to the same account on the JupyterHub deployment.
Issue ticket number and link
Closes #27